pp108 : GetCollection (ISVP) (Deprecated)

GetCollection (ISVP) (Deprecated)


This Web service operation is used to retrieve all XML Objects available in the XMLStore.

SOAP Request

If recursive is 'True', the SOAP Request and Response are as follows:

<GetCollection xmlns="http://schemas.cordys.com/1.0/xmlstore">
    <folder detail="false" recursive="true" version="organization">/Cordys/WCP/Menu/Cordys/</folder>
</GetCollection>

Request Parameters

Parameter

Description

folder

Optional. If specified, it retrieves all the XML Objects under that folder. Default value is 'All'.

recursive

This is used to specify whether to list the XML Objects recursively. When this is used, if any subfolders are encountered, then all the XML Objects in those folders are also retrieved. This attribute takes Boolean values ('true' and 'false'). The default value is 'false'.

detail

This is used to specify whether to list just the XML Objects, or to display the complete XML inside the XML Object. The detail attribute takes Boolean values ('true' and 'false'). The default value is 'false'.

version

This is an optional attribute, ' version '. It determines the version of the XML Store content that will be fetched. It can contain one of the following values:

  • isv
  • organization
  • user

SOAP Response

<GetCollectionResponse xmlns="http://schemas.cordys.com/1.0/xmlstore" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <tuple isFolder="true"
        key="/Cordys/WCP/Menu/Cordys/datasourceconfig"
        lastModified="1237869585499" level="isv" name="datasourceconfig" original="/Cordys/WCP/Menu/Cordys/datasourceconfig"/>
</GetCollectionResponse>

Response Parameters

Parameter

Description

key

Relative path of the XML Object from the collection folder.

lastModified

Last modified value of the XML Object.

name

Name of the XML Object.

isFolder

Holds 'true', if the returned object is a folder.

SOAP Request

If 'recursive' is not set, the SOAP Request and Response are as follows:

<GetCollection xmlns="http://schemas.cordys.com/1.0/xmlstore">
    <folder>/Cordys/WCP/Menu/Cordys</folder>
</GetCollection>

Request Parameters


The request retrieves the list of all XML Objects under specified folder of that organization in the main collection folder.

SOAP Response

<GetCollectionResponse xmlns="http://schemas.cordys.com/1.0/xmlstore" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <tuple key="/Cordys/WCP/Menu/Cordys/test"
        lastModified="1237887191839" level="organization" name="test" original="/Cordys/WCP/Menu/Cordys/test"/>
    <tuple isFolder="true" key="/Cordys/WCP/Menu/Cordys/Testfolder"
        lastModified="1237887237447" level="organization"
        name="Testfolder" original="/Cordys/WCP/Menu/Cordys/Testfolder"/>
    <tuple isFolder="true" key="/Cordys/WCP/Menu/Cordys/TestObject"
        lastModified="1237887244400" level="organization"
        name="TestObject" original="/Cordys/WCP/Menu/Cordys/TestObject"/>
    <tuple isFolder="true"
        key="/Cordys/WCP/Menu/Cordys/datasourceconfig"
        lastModified="1237869585499" level="isv" name="datasourceconfig" original="/Cordys/WCP/Menu/Cordys/datasourceconfig"/>
</GetCollectionResponse>

Response Parameters

Parameter

Description

key

Relative path of the XML Object from the collection folder.

lastModified

Last modified value of the XML Object.

name

Name of the XML Object.

isFolder

Holds 'true', if the returned object is a folder.

level

Specifies the version (user/organization/isv) where the XML Object is created

original

Specifies the correct case of the key as stored in the file system



Note: By default, the XML Object is searched in the current organization. If not found, it is then searched in ISV folder. If the user wants a particular version (user/isv/organization) of XML Object to be retrieved, then the version can be specified in the version attribute of <folder>.